Skip to content

Implement Release Notes page #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 42 commits into from
Closed

Implement Release Notes page #94

wants to merge 42 commits into from

Conversation

PeteBishwhip
Copy link
Member

This pull request includes several significant changes to the app/Support/GitHub.php file and the addition of a new Release class. These changes enhance the functionality for fetching and handling GitHub release data. Additionally, a new view template for displaying release notes has been added.

Enhancements to GitHub support:

  • app/Support/GitHub.php: Added imports for Release and Collection classes.
  • app/Support/GitHub.php: Modified latestVersion method to use the Release class and added a new releases method to fetch multiple releases.
  • app/Support/GitHub.php: Updated fetchLatestVersion to return an instance of Release and added a new fetchReleases method to handle multiple releases.

New Release class:

  • app/Support/GitHub/Release.php: Introduced a new Release class with properties and methods to handle GitHub release data, including conversion of URLs and user mentions to Markdown links.

New view template:

@PeteBishwhip
Copy link
Member Author

Here's a video of the new Release Notes page in action: https://screen.studio/share/hzB5lev6

@PeteBishwhip PeteBishwhip changed the title Feature/release notes Implement Release Notes page Mar 25, 2025
@SRWieZ SRWieZ self-requested a review March 26, 2025 13:52
SRWieZ
SRWieZ approved these changes Mar 26, 2025
View reviewed changes
Copy link
Member

@SRWieZ SRWieZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like this feature. No release notes for mobile docs?

@PeteBishwhip
Copy link
Member Author

Like this feature. No release notes for mobile docs?

Could absolutely implement for mobile too. To do so would require a slight env update to include a GITHUB_TOKEN from @simonhamp so I can make a request to the relevant repo. I don't believe we currently authenticate GH API at all which I why I left it out for now.

@simonhamp - Would you like release notes for Mobile too? Happy to implement if you're happy to include a read-only GITHUB_TOKEN env var? :)

@simonhamp
Copy link
Member

We can leave it for mobile for now... I'm sharing publicly via Anystack - so we could link to that, but I wouldn't worry for now.

One thing I'd really like here is to reduce the URLs to PRs down to just their number, i.e. #123 and then make that the link, as right now it feels like there's a lot of repetition and it adds visual noise that makes the page feel a bit busy

simonhamp and others added 20 commits March 26, 2025 18:35
@simonhamp @PeteBishwhip
Update docs
7f76946
@HassanZahirnia @PeteBishwhip
✨ Add lazy loading to images and improve text formatting in welcome view
81baf6b
@HassanZahirnia @PeteBishwhip
✨ Enhance welcome view with animated SVG and update image dimensions
866ddeb
@HassanZahirnia @PeteBishwhip
✨ Revamp video section with animated play button and improved layout
bc0350d
@HassanZahirnia @PeteBishwhip
✨ Update image dimensions and improve layout in welcome view
6507fe9
@HassanZahirnia @PeteBishwhip
✨ Update contributor images scaling and enhance layout in welcome view
f2c8005
@HassanZahirnia @PeteBishwhip
✨ Replace SVG play button with reusable component and improve layout …
ca2e074 
…in video section
@HassanZahirnia @PeteBishwhip
✨ Refactor footer and welcome views for improved layout and responsiv…
91e9b8a 
…eness
@HassanZahirnia @PeteBishwhip
✨ Update primary color for DocSearch and add rounded corners to the form
92a2973
@HassanZahirnia @PeteBishwhip
✨ Adjust gap spacing in navigation bar for improved layout consistency
3e18722
@HassanZahirnia @PeteBishwhip
✨ Update theme toggle component styles for improved consistency and r…
c5aa15f 
…esponsiveness
@HassanZahirnia @PeteBishwhip
✨ Improve pricing warning gap with its text
34945aa
@HassanZahirnia @PeteBishwhip
✨ Refactor EAP banner for improved text animation and layout
4c39dec
@HassanZahirnia @PeteBishwhip
✨ Add new color palette and update components for dark mode consistency
9345e64
@HassanZahirnia @PeteBishwhip
✨ Update electronGitHubVersion sharing logic for production and devel…
251a200 
…opment environments
@HassanZahirnia @PeteBishwhip
✨ Update alert-beta component background opacity for improved visibility
07fc93d
@HassanZahirnia @PeteBishwhip
✨ Update sidebar navigation styles for improved responsiveness and da…
a06385d 
…rk mode compatibility
@HassanZahirnia @PeteBishwhip
✨ Add custom scrollbar styles for light and dark themes
6037ed6
@HassanZahirnia @PeteBishwhip
✨ Update spacing and styling for sponsors section in TOC component
4c5d221
@HassanZahirnia @PeteBishwhip
✨ Update dark mode styles across various components for improved cons…
ec14cbf 
…istency
HassanZahirnia and others added 18 commits March 26, 2025 18:35
@HassanZahirnia @PeteBishwhip
✨ Update sidebar-left-navigation component styles for improved layout…
834a067 
… and spacing
@HassanZahirnia @PeteBishwhip
✨ Update layout and styling for various components to enhance respons…
7fddbaf 
…iveness and visual consistency
@HassanZahirnia @PeteBishwhip
✨ Refactor shared view variable registration for cleaner code and imp…
0c5b16a 
…roved readability
@HassanZahirnia @PeteBishwhip
✨ Update alignment of text in welcome view for improved layout consis…
e009b40 
…tency
@olivsinz @PeteBishwhip
Update support-policy.md
11d8dd7
@HassanZahirnia @PeteBishwhip
✨ Update navigation bar version badge styles for improved visibility …
62a7711 
…and consistency
@HassanZahirnia @PeteBishwhip
✨ Update layout classes for improved responsiveness and consistency a…
be87d83 
…cross components
@HassanZahirnia @PeteBishwhip
✨ Update sponsor link styles for improved consistency and layout
079178d
@HassanZahirnia @PeteBishwhip
✨ Update footer links to reflect new X.com URLs for improved accuracy
c1ec5f4
@HassanZahirnia @PeteBishwhip
✨ Update Borah logo dimensions for improved display and adjust styles…
c46a4de 
… for better visibility
@HassanZahirnia @PeteBishwhip
✨ Update featured sponsor images with specified dimensions for improv…
9579b62 
…ed display
@HassanZahirnia @PeteBishwhip
✨ Improve sponsor images
0c1b6e9
@HassanZahirnia @PeteBishwhip
✨ Integrate DocSearch for improved site search functionality
bc0a312
@HassanZahirnia @PeteBishwhip
✨ Update responsive breakpoints for improved layout on larger screens
807bc14
@HassanZahirnia @PeteBishwhip
✨ Adjust padding and text alignment for improved layout in documentat…
bad6cc6 
…ion index
@HassanZahirnia @PeteBishwhip
✨ Refactor DocSearch button styles for improved responsiveness and ad…
97c1e7b 
…just logo size in navigation bar
@simonhamp @PeteBishwhip
Fix config
e88e587
@PeteBishwhip
Update Release Note Markdown processing to reduce PR link sizes.
d690571
@PeteBishwhip PeteBishwhip mentioned this pull request Mar 27, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SRWieZ SRWieZ SRWieZ approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@PeteBishwhip @simonhamp @SRWieZ @HassanZahirnia @olivsinz